ArcPad Map File Schema
TOOLBAR Element
See Also  Send comments on this topic.
ArcPad Map File Schema : TOOLBAR Element

Glossary Item Box

Description

Used to define a toolbar.

Diagram

TOOLBUTTON Element SEPARATOR Element Sequence TOOLBAR Element

Overview

TOOLBAR
Used to define a toolbar.
buttonsize optional Restriction of xs:int
Specifies the scale factor for the size of toolbar buttons on this toolbar. For example, a value of 2 makes toolbar buttons twice as large as the standard size (16X16). This setting overrides the buttonsize attribute in the DISPLAY element (in ArcPadPrefs.apx).
caption optional xs:string
Displayed in the toolbar.
image optional xs:string
Path to a 16X16 .bmp image file, .ico file or the name of a built-in image (for example, $bex).
name optional xs:string

When parent is ToolButton:

Custom tool name. Used to reference the tool in scripts.
visible optional Restriction of xs:string
Sequence
SEPARATOR 1..∞
Used to specify a separator between tools in a custom toolbar.
TOOLBUTTON 1..∞
Used to define a custom toolbutton or specify a built-in toolbutton in a toolbar.
command optional xs:string

When parent is ToolButton:

 Built-in tool name (for example, addlayer).
image optional xs:string
Path to a 16X16 .bmp image file, .ico file or the name of a built-in image (for example, $bex).
name optional xs:string

When parent is ToolButton:

Custom tool name. Used to reference the tool in scripts.
shortcut optional xs:string

The function key or action button shortcut for the custom tool button.
onclick optional xs:string
Specify the script to run when this event occurs.
onpointerdown optional xs:string
Specify the script to run when this event occurs.
onpointermove optional xs:string
Specify the script to run when this event occurs.
onpointerup optional xs:string
Specify the script to run when this event occurs.
prompt optional xs:string

The status bar text for the custom tool button.
tooltip optional xs:string

When parent is ToolButton:

Tooltip to display when the mouse pointer is on the custom tool (desktop only).
Sequence
MENUITEM 1..∞
Used to define a custom toolbutton or specify a built-in toolbutton in a pull-down menu.
caption optional xs:string
Displayed in the toolbar.
command optional xs:string

When parent is ToolButton:

 Built-in tool name (for example, addlayer).
image optional xs:string
Path to a 16X16 .bmp image file, .ico file or the name of a built-in image (for example, $bex).
name optional xs:string

When parent is ToolButton:

Custom tool name. Used to reference the tool in scripts.
onclick optional xs:string
Specify the script to run when this event occurs.
onpointerdown optional xs:string
Specify the script to run when this event occurs.
onpointermove optional xs:string
Specify the script to run when this event occurs.
onpointerup optional xs:string
Specify the script to run when this event occurs.
promote optional Restriction of xs:string
Specifies whether the custom menu item will be promoted to the top of the list when selected.
prompt optional xs:string

The status bar text for the custom tool button.
shortcut optional xs:string

The function key or action button shortcut for the custom tool button.

Attributes

NameTypeUseDefaultFixedDescription
buttonsizeRestriction of xs:intoptional1 Specifies the scale factor for the size of toolbar buttons on this toolbar. For example, a value of 2 makes toolbar buttons twice as large as the standard size (16X16). This setting overrides the buttonsize attribute in the DISPLAY element (in ArcPadPrefs.apx).
captionxs:stringoptional  Displayed in the toolbar.
imagexs:stringoptional  Path to a 16X16 .bmp image file, .ico file or the name of a built-in image (for example, $bex).
namexs:stringoptional  

When parent is ToolButton:

Custom tool name. Used to reference the tool in scripts.

visibleRestriction of xs:stringoptionalfalse  

Remarks

The visible attribute is used to specifies if the toolbar is visible or hidden.

Examples

Restrictions

  • If the name attribute value is "main", "browse", or "draw", then the caption and image attributes cannot be used.

Source

<xs:element name="TOOLBAR" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element maxOccurs="unbounded" name="SEPARATOR">
        <xs:complexType />
      </xs:element>
      <xs:element maxOccurs="unbounded" name="TOOLBUTTON">
        <xs:complexType>
          <xs:sequence>
            <xs:element maxOccurs="unbounded" name="MENUITEM">
              <xs:complexType>
                <xs:attribute ref="caption" />
                <xs:attribute ref="command" />
                <xs:attribute ref="image" />
                <xs:attribute ref="name" />
                <xs:attribute ref="onclick" />
                <xs:attribute ref="onpointerdown" />
                <xs:attribute ref="onpointermove" />
                <xs:attribute ref="onpointerup" />
                <xs:attribute default="false" name="promote">
                  <xs:simpleType>
                    <xs:restriction base="xs:string">
                      <xs:enumeration value="true" />
                      <xs:enumeration value="false" />
                    </xs:restriction>
                  </xs:simpleType>
                </xs:attribute>
                <xs:attribute ref="prompt" />
                <xs:attribute ref="shortcut" />
              </xs:complexType>
            </xs:element>
          </xs:sequence>
          <xs:attribute ref="command" />
          <xs:attribute ref="image" />
          <xs:attribute ref="name" />
          <xs:attribute ref="shortcut" />
          <xs:attribute ref="onclick" />
          <xs:attribute ref="onpointerdown" />
          <xs:attribute ref="onpointermove" />
          <xs:attribute ref="onpointerup" />
          <xs:attribute ref="prompt" />
          <xs:attribute ref="tooltip" />
        </xs:complexType>
      </xs:element>
    </xs:sequence>
    <xs:attribute ref="buttonsize" />
    <xs:attribute ref="caption" />
    <xs:attribute ref="image" />
    <xs:attribute ref="name" />
    <xs:attribute ref="visible" />
  </xs:complexType>
</xs:element>

See Also

© 2012 All Rights Reserved.